docs: add comprehensive contributor documentation#5
docs: add comprehensive contributor documentation#5uvenkatateja wants to merge 2 commits intomacaly:mainfrom
Conversation
|
@petrbrzek Added contributor documentation (CONTRIBUTING.md + GitHub templates). Let me know if you'd like any changes! |
|
@uvenkatateja thanks I'll check it out later today or tomorrow. |
petrbrzek
left a comment
petrbrzek
left a comment
There was a problem hiding this comment.
Thanks for putting this together! Contributor docs are useful, but there are several accuracy issues that would need to be fixed before we could merge this.
Incorrect project structure - CONTRIBUTING.md shows src/frameworks/vite/ and src/frameworks/next/ as subdirectories, but the actual files are flat: src/frameworks/vite-dev-server.ts, src/frameworks/next-dev-server.ts, etc. It also lists src/worker/ and docs/ which don't exist.
Wrong API in code examples - The examples use createContainer and container.execute(), but the real API is createRuntime. This affects both CONTRIBUTING.md and the bug report template.
Wrong commands - References npm run build:lib and npm run type-check, but the actual commands are npm run build and npm run test:run.
Missing core principle - The most important thing a contributor needs to know is: "never write library-specific shim code, fix the platform instead." When a package doesn't work, the fix goes into the generic shims (fs, path, etc.), not into a package-specific adapter. This isn't mentioned anywhere.
Conventional commits - CONTRIBUTING.md recommends conventional commit format, but the project doesn't use it.
These inaccuracies would actively mislead new contributors, so we can't merge as-is. If you'd like to revise with the correct structure, API, and commands, we'd be happy to take another look.
- Correct project structure (frameworks files are flat, not nested) - Fix API examples (use createRuntime instead of createContainer) - Update npm scripts (build instead of build:lib, test:run exists) - Add core principle: fix the platform, not the package - Remove conventional commits format (project doesn't use it) - Update bug report template with correct API
|
@petrbrzek Thanks for the detailed feedback! I've fixed all the issues you mentioned: ✅ Corrected project structure - frameworks files are flat (vite-dev-server.ts, next-dev-server.ts), removed non-existent directories The documentation should now accurately reflect the project structure and guide contributors correctly. Let me know if there's anything else that needs adjustment! |
2 participants
Adds contributor documentation to help new contributors get started and improve issue quality.
What's Added
CONTRIBUTING.md- Complete setup guide, workflow, and guidelinesCODE_OF_CONDUCT.md- Community standardsWhy
The project currently has no contributor documentation. This makes it easier for new contributors to start and helps maintainers get complete bug reports.
Follows standard patterns from React, Vite, and Next.js.